Workbench Design/WB Collection.iso/datatypes/xpkdt/xpkdt.guide

Amigaguide Document | 1996-04-07 | 11KB | 241 lines

@database XPKDT
@$VER: XPKDT.guide 39.1 (21.11.95)
@(C) Michal Letowski
@author Michal Letowski
@index Index
@node Main "XPKDT 1.0
@prev Main
@next Main
                                 @{b}@{u}XPKDT 1.0
@{uu}@{ub}
             @{b}XPKDT@{ub} package is Copyright
 1995 @{"Michal Letowski" link Author}.
                             All rights reserved.
      The author's native language is Polish, so please forgive bad spelling,
  grammar mistakes etc. Or better - correct them.
  @{"Copyright notice" link Copyright} - legal informations.
  @{"  Introduction  " link Introduction} - what it is useful for.
  @{"  Requirements  " link Requirements} - what you need to run.
  @{"  Installation  " link Installation} - how to install.
  @{"      Notes     " link Notes} - some notes and comments.
  @{"     History    " link History} - what has changed since last release.
  @{"      To do     " link ToDo} - this is @{u}BETA@{uu} version!
  @{"     xpk_dtc    " link AutoDocs/xpk_dtc.doc/main} - programmer's documentation.
@endnode
@node Copyright "XPKDT Copyright"
@prev Copyright
  @{b}@{u}Copyright@{uu}@{ub}
  @{b}XPKDT@{ub} package is Copyright
 1995 @{"Michal Letowski" link Author}.
  @{b}XPKDT@{ub} is freely distributable under the following conditions:
 no more than a reasonable fee is charged for copying/downloading;
 this distribution is not a part of other non-free distribution;
 the distribution is complete - it contains all the files (full list
      at the end of this chapter);
 no file in the distribution is changed.
      Distribution without meeting conditions specified above requires
  written permission from me.
      The @{"DataType" link DataTypes} from the package works, but no guarantee is given nor
  implied. In no case will I be liable for any results of using supplied
  @{"DataType" link DataTypes}.
      The source code is provided only for informational purposes and is
  also under copyright. It is based on source for @{i}cli.datatype @{ui}by Stefan
  Ruppert, who had the great idea of "unwrapping" formats.
      This documentation is based on @{i}CatEdit.guide@{ui}, which is Copyright
  1993 Rafael D'Halleweyn.
      @{"XPK" link XPK} Data Compression Package was created by Urban Dominik Mueller.
      @{"PowerPacker" link PowerPacker} is Copyright
 1990 Nico Fran
  List of all files in the distribution:
    @{i}Install XPKDT.info
    Install XPKDT
    XPKDT.guide.info
    XPKDT.guide
    AutoDocs
      xpk_dtc.doc
    Devs.info
    Devs (dir)
      DataTypes.info
      DataTypes (dir)
          Power Packer.info
          Power Packer
          XPK.info
          XPK
    Libs (dir)
      DataTypes (dir)
        xpk.datatype
    Src (dir)
      classbase.c
      dispatch.c@{ui}
@endnode
@node Introduction "Introduction to XPKDT"
  @{b}@{u}Introduction@{uu}@{ub}
      @{b}XPKDT@{ub} is a @{"DataTypes" link DataTypes} sub-class for loading @{"XPK" link XPK} compressed files.
  @{b}XPKDT@{ub} handles decompression and passes decompressed files back to
  @{"DataTypes" link DataTypes}. In the end the user is able to utilize/view compressed files
  using any @{"DataTypes" link DataTypes} compliant application.
      @{b}XPKDT@{ub} will also decompress @{"Power Packer" link PowerPacker} compressed files thanks to a
  kludge in @{"XPK" link XPK} system.
@endnode
@node Requirements "Requirements for XPKDT"
  @{b}@{u}Requirements@{uu}@{ub}
      @{b}XPKDT@{ub} requires AmigaDOS 3.0 or higher (@{i}datatypes.library @{ui}V39+). @{"XPK" link XPK}
  subsystem (@{i}xpkmaster.library@{ui}) must also be installed with all necessary
  compression sub-libraries.
      @{b}XPKDT@{ub} requires some temporary disk space to store decompressed data.
  By convention it will use @{i}T: @{ui}logical device for all temporary files.
@endnode
@node Installation "Installation of XPKDT"
  @{b}@{u}Installation@{uu}@{ub}
      Use supplied @{i}Installer @{ui}script to copy necessary files. You can choose
  to have @{b}XPKDT@{ub} permanently enabled or manually selectable. In the former
  case recognition files will be copied into @{i}DEVS:DataTypes@{ui} directory, while
  in the latter - into @{i}SYS:Storage/DataTypes@{ui} directory.
      Manually selectable installation requires @{b}XPKDT@{ub} to be activated before
  use by double-clicking on @{i}SYS:Storage/DataTypes/Power Packer @{ui}or
  @{i}SYS:Storage/DataTypes/XPK @{ui}icons or typing
      @{b}1.SYS:>@{ub} AddDataTypes SYS:Storage/DataTypes/#?
  from Shell.
@endnode
@node Notes "XPKDT Notes"
  @{b}@{u}Notes@{uu}@{ub}
      @{b}XPKDT@{ub} is only a temporary solution! Decompression and decryption
  should be handled on higher level, perhaps by @{i}datatypes.library@{ui} itself.
      If (despite it's shortcomings) you still like @{b}XPKDT@{ub} be sure to send
  "Thank You" message to Stefan Ruppert (@{i}http://www.uni.mainz/~ruppert@{ui},
  @{i}mailto://[e-mail]@{ui},
  @{i}mailto://[e-mail]@{ui}) who had the original idea. I'm
  merely trying to implement it...
      @{b}XPKDT@{ub} creates temporary directories and files on @{i}T: @{ui}logical device.
      @{b}XPKDT@{ub} will properly handle multi-compressed files (eg. @{"XPK" link XPK} files
  compressed again with @{"Power Packer" link PowerPacker}).
      @{"DataTypes" link DataTypes} system often uses file name to determine type of a file.
  Therefore it is recommended that you don't append any suffixes to names of
  your compressed files.
@endnode
@node History "XPKDT History"
  @{b}@{u}History@{uu}@{ub}
      Version 1.0
 (21.11.95) - initial BETA release.
@endnode
@node ToDo "To do in XPKDT"
@next ToDo
  @{b}@{u}To do@{uu}@{ub}
      This is BETA release! This program does not work in all cases and may
  crash your system! But the bugs come from some interference with other
  @{"DataTypes" link DataTypes}, not bad programming on my part. I can't test @{b}XPKDT@{ub} further,
  because I run only AmigaDOS 3.0. Comments from users with AmigaDOS 3.1 are
  welcomed!
      @{b}XPKDT@{ub} can't process packed AmigaGuide
 files - the link buttons
  become unselectable (in @{i}amigaguide.datatype @{ui}V39). You can, however, view
  compressed files linked to AmigaGuide
 buttons.
      There are some open issues not addressed in this release of @{b}XPKDT@{ub}. In
  particular, I would like to hear from you opinions on how to handle:
 progress indication. I think it should be handled on higher level,
  preferably by @{i}datatypes.library@{ui} (@{i}DTA_ProgressHook@{ui}?).
 passwords. At present, @{b}XPKDT@{ub} does not support passwords and therefore
  will not work with encrypted files.
 error reporting. Current version converts @{"XPK" link XPK} error codes to standard
  AmigaDOS error codes and therefore does not take advantage of @{"XPK" link XPK}
  descriptive error messages. Alas, I can see no way to change this...
@endnode
@node DataTypes "DataTypes Information"
@prev DataTypes
@next DataTypes
  @{b}@{u}DataTypes@{uu}@{ub}
      @{b}DataTypes @{ub}is an AmigaDOS subsystem (introduced in AmigaDOS 3.0) for
  dealing with different types of files found on different machines (PC's,
  Macs and Amigas). @{b}DataTypes @{ub}can be used for recognizing types of files
  and interpreting informations in this files. An example of the latter is
  @{i}MultiView@{ui}, which can show many types of data.
      @{b}DataTypes @{ub}divide all files into the following main categories:

 @{i}syst @{ui}(System) - system files;

 @{i}text @{ui}(Text) - textual files;

 @{i}docu @{ui}(Document) - documents (spreadsheet data, text with
        pictures etc.);

 @{i}soun @{ui}(Sound) - sound samples;

 @{i}inst @{ui}(Instrument) - musical instruments;

 @{i}musi @{ui}(Music) - songs;

 @{i}pict @{ui}(Picture) - graphics;

 @{i}anim @{ui}(Animation) - animations;

 @{i}movi @{ui}(Movie) - animation with sound.
      Each category is further divided into sub-classes. Each sub-class
  interprets one type of file, converting it into some universal format.
  @{i}xpk.datatype @{ui}is a subclass of System group.
@endnode
@node XPK "XPK System"
@prev XPK
@next XPK
  @{b}@{u}XPK System@{uu}@{ub}
      In @{b}XPK@{ub} author's words:
      For a long time, there have been various compression programs for
  different purposes on the Amiga. But every application supported only one
  compressor, and most compressors were only supported by one application.
  @{b}XPK@{ub} wants to put an end to this: Every application with @{b}XPK@{ub} interface can
  use every packer with @{b}XPK@{ub} interface. An @{b}XPK@{ub} packer is a library with a
  four letter library name.
@endnode
@node PowerPacker "Power Packer"
@prev PowerPacker
@next PowerPacker
  @{b}@{u}Power Packer@{uu}@{ub}
      @{b}Power Packer@{ub} is a very popular compression program, useful for
  packing both data and executable files. It comes with a support library,
  which allows programmers to utilize compression in their programs.
@endnode
@node Author "About the Author"
@prev Author
@next Author
  @{b}@{u}About the Author@{uu}@{ub}
      @{b}XPKDT@{ub} package was written by @{b}Michal Letowski@{ub}, who holds Master degree
  in Computer Science and is currently looking for a good job.
      If you have something to say me (questions, remarks, suggestions,
  wishes, bug reports) please contact me (I like receiving mail!):
    by E-Mail (preferred way):
      @{b}[e-mail]@{ub} (valid until 1.3.96)
    by normal mail:
      @{b}Michal Letowski
      Przyjazni 51/17
      53-030 Wroclaw
      POLAND@{ub}
      You can get my other free software:
   @{" MCommands " link MCommands.guide/main} - 8 useful AmigaDOS CLI commands
      (@{i}Aminet://util/cli/MComms-1.4.lha@{ui});
   @{"    MCEd   " link MCEd.guide/main} - 8 great ARexx scripts for @{i}CygnusEd @{ui}users
      (@{i}Aminet://text/edit/MCEd-1.2.lha@{ui});
   @{"ClipHandler" link ClipHandler.guide/main} - easily exchange data between AmigaDOS and applications
      (@{i}Aminet://util/misc/ClipHan-1.2.lha@{ui});
   @{"   FontDT  " link FontDT.guide/main} - DataType for Amiga fonts.
      (@{i}Aminet://util/dtype/FontDT-1.1.lha@{ui});
   @{"   MREKO   " link MREKO.guide/main} - DataType for viewing @{i}REKO @{ui}cardsets
      (@{i}Aminet://util/dtype/MREKO-1.0.lha@{ui}).
@endnode
@node Index "XPKDT Index"
@prev Index
@next Index
  @{b}@{u}Index@{uu}@{ub}
  @{"     Author     " link Author}
  @{"Copyright notice" link Copyright}
  @{"    DataTypes   " link DataTypes}
  @{"     History    " link History}
  @{"  Installation  " link Installation}
  @{"  Introduction  " link Introduction}
  @{"      Notes     " link Notes}
  @{"   PowerPacker  " link PowerPacker}
  @{"  Requirements  " link Requirements}
  @{"      To do     " link ToDo}
  @{"       XPK      " link XPK}
  @{"     xpk_dtc    " link AutoDocs/xpk_dtc.doc/main}
@endnode